home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / gui / bgui11b.lha / docs / filereqclass.doc < prev    next >
Encoding:
Text File  |  1994-07-05  |  3.1 KB  |  109 lines
  1.  
  2.            $RCSfile: filereqclass.doc,v $
  3.         Description: Filereqclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.1 $
  10.               $Date: 1994/07/04 21:05:30 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. filereqclass/--background--
  16. filereqclass/Methods
  17. filereqclass/Attributes
  18.  
  19. filereqclass/--background--                        filereqclass/--background--
  20.  
  21.     NAME
  22.         Class:          filereqclass
  23.         Superclass:     ROOTCLASS
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide  a  BOOPSI  interface  class to the ASL FileRequester. The
  28.         advantage  of  this  class is that the objects remember their complete
  29.         settings  like  requester  size,  path,  directory,  file  and pattern
  30.         strings as long as the object remains valid.
  31.  
  32. filereqclass/Methods                                      filereqclass/Methods
  33.  
  34.     NEW METHODS
  35.         FRM_DOREQUEST -- Sending  this  method  to  the  object  will open the
  36.                 requester.
  37.  
  38.                 This method can return any of the following return codes:
  39.  
  40.                 FRQ_OK            -- Ok. No problems.
  41.                 FRQ_CANCEL        -- The requester was cancelled by the user.
  42.                 FRQ_ERROR_NO_MEM  -- Out of memory.
  43.                 FRQ_ERROR_NO_FREQ -- Could  not   allocate   a   FileRequester
  44.                         structure.
  45.  
  46.     CHANGED METHODS
  47.         OM_SET -- This method returns 0 when everything went OK. Uppon failure
  48.                 it will return FRQ_ERROR_NO_MEM.
  49.  
  50. filereqclass/Attributes                                filereqclass/Attributes
  51.  
  52.     NOTE
  53.         All  the  ASL filerequester attributes as defined in <libraries/asl.h>
  54.         are  usable  with this class. Applicability  for  these ASL attributes
  55.         is (ISGU).
  56.  
  57.     NAME
  58.         FRQ_Drawer -- ( STRPTR )
  59.  
  60.     FUNCTION
  61.         To obtain a pointer to the directory name of the filerequester.
  62.  
  63.         Applicability is (G).
  64.  
  65.     SEE ALSO
  66.         FRQ_File, FRQ_Pattern, FRQ_Path
  67.  
  68.     NAME
  69.         FRQ_File -- ( STRPTR )
  70.  
  71.     FUNCTION
  72.         To obtain a pointer to the file name of the filerequester.
  73.  
  74.         Applicability is (G).
  75.  
  76.     SEE ALSO
  77.         FRQ_Drawer, FRQ_Pattern, FRQ_Path
  78.  
  79.     NAME
  80.         FRQ_Pattern -- ( STRPTR )
  81.  
  82.     FUNCTION
  83.         To obtain a pointer to the pattern string of the filerequester.
  84.  
  85.         Applicability is (G).
  86.  
  87.     SEE ALSO
  88.         FRQ_Drawer, FRQ_File, FRQ_Path
  89.  
  90.     NAME
  91.         FRQ_Path -- ( STRPTR )
  92.  
  93.     FUNCTION
  94.         To  obtain  a  pointer  to the full path of the filerequester. This is
  95.         simply the directory with the file name AddPart()'d to it.
  96.  
  97.         Applicability is (G)
  98.  
  99.     SEE ALSO
  100.         FRQ_Drawer, FRQ_File, FRQ_Pattern, dos.library/AddPart()
  101.  
  102.     NAME
  103.         FRQ_Left, FRQ_Top, FRQ_Width, FRQ_Height -- ( ULONG )
  104.  
  105.     FUNCTION
  106.         To obtain the current position and size of the filerequester.
  107.  
  108.         Applicability is (G).
  109.